Package com.cisco.pt.ipc.sim
Interface Cluster
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
ClusterImpl
Information provided by the PKI file:
\class Cluster
\brief Clusters used to group clusters inside logical workspace
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptiondoubleInformation provided by the PKI file:doubleInformation provided by the PKI file:getChildClusterAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getId()Information provided by the PKI file:getName()Information provided by the PKI file:Information provided by the PKI file:doubleInformation provided by the PKI file:doubleInformation provided by the PKI file:booleanmoveToLocation(int x, int y) Information provided by the PKI file:booleanmoveToLocationCentered(int x, int y) Information provided by the PKI file:voidsetIconPath(String str) Information provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
setName
Information provided by the PKI file:
\brief Allows to change cluster name to newName. \param newName, name to use.- Parameters:
newName- Takes in a parameter of newName
-
getName
String getName()Information provided by the PKI file:
\brief Returns cluster name. \return QString, value is the cluster name.- Returns:
- String Returns a String
-
getId
String getId()Information provided by the PKI file:
\brief Returns cluster ID. \return QString, value is the ID of the cluster.- Returns:
- String Returns a String
-
getChildClusterCount
int getChildClusterCount()Information provided by the PKI file:
\brief Returns the number of child cluster objects \return int, the number of child clusters inside the cluster.- Returns:
- int Returns a int
-
getChildClusterAt
Information provided by the PKI file:
\brief Returns child cluster object at a given index \param index, the index of child cluster to return. \return Cluster, value is the child cluster at the given index. Range(0, getContainerCount()-1)- Parameters:
index- Takes in a parameter of index- Returns:
- Cluster Returns a Cluster
-
getParentCluster
Cluster getParentCluster()Information provided by the PKI file:
\brief Returns parent cluster object \return Cluster, value is the parent of the cluster.- Returns:
- Cluster Returns a Cluster
-
getXCoordinate
double getXCoordinate()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Logical workspace for this cluster. \return double, the current x-coordinate.- Returns:
- double Returns a double
-
getYCoordinate
double getYCoordinate()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Logical workspace for this cluster. \return double, the current y-coordinate.- Returns:
- double Returns a double
-
getCenterXCoordinate
double getCenterXCoordinate()Information provided by the PKI file:
\brief Returns the current x-coordinate position in the Logical workspace for this cluster. \return double, the current x-coordinate.- Returns:
- double Returns a double
-
getCenterYCoordinate
double getCenterYCoordinate()Information provided by the PKI file:
\brief Returns the current y-coordinate position in the Logical workspace for this cluster. \return double, the current y-coordinate.- Returns:
- double Returns a double
-
moveToLocationCentered
boolean moveToLocationCentered(int x, int y) Information provided by the PKI file:
\brief Moves this cluster to the specified location for its center in Logical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
moveToLocation
boolean moveToLocation(int x, int y) Information provided by the PKI file:
\brief Moves this cluster to the specified location in Logical workspace. \param x, the new x-coordinate position. \param y, the new y-coordinate position. \return bool, true if successful, otherwise false.- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of y- Returns:
- boolean Returns a boolean
-
setIconPath
Information provided by the PKI file:
\brief Sets the icon to use for the cluster. \param str, path to the image to use for the cluster icon.- Parameters:
str- Takes in a parameter of str
-
getIconPath
String getIconPath()Information provided by the PKI file:
\brief Returns the path to the image to use for the cluster icon. \return QString, the cluster image icon path.- Returns:
- String Returns a String
-